API Documentation
Public Member Functions | List of all members
nkDebug::OutputFormatter Class Reference

Base class for test's output formatting. More...

Inheritance diagram for nkDebug::OutputFormatter:
nkDebug::ConsoleOutputFormatter

Public Member Functions

 OutputFormatter ()
 
virtual ~OutputFormatter ()
 
virtual nkLog::String formatClassLaunch (const TestClassObserverInformation &info)
 
virtual nkLog::String formatClassBypass (const TestClassObserverInformation &info)
 
virtual nkLog::String formatClassEnd (const TestClassObserverInformation &info)
 
virtual nkLog::String formatTestLaunch (const TestFunctionObserverInformation &info)
 
virtual nkLog::String formatTestBypass (const TestFunctionObserverInformation &info)
 
virtual nkLog::String formatTestSuccess (const TestFunctionObserverInformation &info)
 
virtual nkLog::String formatTestFailure (const TestFunctionObserverInformation &info)
 

Detailed Description

Base class for test's output formatting.

To format results from tests, it is possible to implement this class. It can then be plugged within a test run's parameter structure.

Constructor & Destructor Documentation

◆ OutputFormatter()

nkDebug::OutputFormatter::OutputFormatter ( )

Default constructor.

◆ ~OutputFormatter()

virtual nkDebug::OutputFormatter::~OutputFormatter ( )
virtual

Destructor.

Member Function Documentation

◆ formatClassLaunch()

virtual nkLog::String nkDebug::OutputFormatter::formatClassLaunch ( const TestClassObserverInformation info)
virtual

Called when a TestClass is being prepared to run its functions.

Parameters
infoCurrent information about the run.
Returns
Returns a formatted string to use for logging.

Reimplemented in nkDebug::ConsoleOutputFormatter.

◆ formatClassBypass()

virtual nkLog::String nkDebug::OutputFormatter::formatClassBypass ( const TestClassObserverInformation info)
virtual

Called when a TestClass is being bypassed.

Parameters
infoCurrent information about the run.
Returns
Returns a formatted string to use for logging.

Reimplemented in nkDebug::ConsoleOutputFormatter.

◆ formatClassEnd()

virtual nkLog::String nkDebug::OutputFormatter::formatClassEnd ( const TestClassObserverInformation info)
virtual

Called when a TestClass finished running its functions.

Parameters
infoCurrent information about the run.
Returns
Returns a formatted string to use for logging.

Reimplemented in nkDebug::ConsoleOutputFormatter.

◆ formatTestLaunch()

virtual nkLog::String nkDebug::OutputFormatter::formatTestLaunch ( const TestFunctionObserverInformation info)
virtual

Called when a TestClass' test function is starting.

Parameters
infoCurrent information about the run.
Returns
Returns a formatted string to use for logging.

Reimplemented in nkDebug::ConsoleOutputFormatter.

◆ formatTestBypass()

virtual nkLog::String nkDebug::OutputFormatter::formatTestBypass ( const TestFunctionObserverInformation info)
virtual

Called when a TestClass' test function is bypassed.

Parameters
infoCurrent information about the run.
Returns
Returns a formatted string to use for logging.

Reimplemented in nkDebug::ConsoleOutputFormatter.

◆ formatTestSuccess()

virtual nkLog::String nkDebug::OutputFormatter::formatTestSuccess ( const TestFunctionObserverInformation info)
virtual

Called when a TestClass' test function is succeeding.

Parameters
infoCurrent information about the run.
Returns
Returns a formatted string to use for logging.

Reimplemented in nkDebug::ConsoleOutputFormatter.

◆ formatTestFailure()

virtual nkLog::String nkDebug::OutputFormatter::formatTestFailure ( const TestFunctionObserverInformation info)
virtual

Called when a TestClass' test function is failing.

Parameters
infoCurrent information about the run.
Returns
Returns a formatted string to use for logging.

Reimplemented in nkDebug::ConsoleOutputFormatter.


The documentation for this class was generated from the following file: